Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Configuration INIT_SCRIPTS_PATH Description #654

Merged
merged 2 commits into from
Sep 11, 2023

Conversation

aroxby-wayscript
Copy link
Contributor

On the page, https://docs.localstack.cloud/references/configuration/ This section:

Deprecated. Specify the path to the initializing files with extensions .sh that are found default in /docker-entrypoint-initaws.d.

Should read:

Deprecated. Specify the path to the initializing files with extensions .sh that are found default in /etc/localstack/init/ready.d.

This was confusing for me as the init-hooks reference page is not as easily found.

Alternatively, the docs for INIT_SCRIPTS_PATH could link to the init-hooks docs.

On the page, https://docs.localstack.cloud/references/configuration/
This section:
> _Deprecated_. Specify the path to the initializing files with extensions `.sh` that are found default in `/docker-entrypoint-initaws.d`.

Should read:
> _Deprecated_. Specify the path to the initializing files with extensions `.sh` that are found default in `/etc/localstack/init/ready.d`.

This was confusing for me as the [init-hooks](https://docs.localstack.cloud/references/init-hooks/) reference page is not as easily found.

Alternatively, the docs for `INIT_SCRIPTS_PATH` could link to the init-hooks docs.
@github-actions
Copy link

github-actions bot commented May 31, 2023

🎊 PR Preview has been successfully built and deployed to https://localstack-docs-preview-pr-654.surge.sh 🎊

@aroxby-wayscript
Copy link
Contributor Author

Is PR correct or did I skip a step? Pinging @steffyP and @HarshCasper, please help.

@thrau thrau self-requested a review August 29, 2023 15:50
@thrau thrau self-assigned this Aug 29, 2023
Copy link
Member

@thrau thrau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey Andy @aroxby-wayscript! Sorry this fell through the cracks. The configuration.md has changed in the meantime (we moved all deprecated variables into their own section), and I think we should remove this variable all together, or at least mark it as defunct. It's not just deprecated, its not being used any more at all since you cannot configure the path to the init hooks anymore.

So maybe something like

**Deprecated**. Before 1.0, this was used to configure the path to the initializing files with extensions .shthat were found in/docker-entrypoint-initaws.d. This has been replaced by the init-hook system (and link to the init hooks)

@aroxby-wayscript
Copy link
Contributor Author

Thanks for the update @thrau! I'd like to keep this variable in the list and include a link to the init hook system. Having this link here would have saved me a little bit of a headache when I was trying to get setup.

@thrau thrau self-requested a review September 11, 2023 17:14
Copy link
Member

@thrau thrau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot!

@thrau thrau merged commit bba0a39 into localstack:main Sep 11, 2023
@aroxby-wayscript aroxby-wayscript deleted the patch-1 branch September 11, 2023 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants